<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-type" content="text/html;charset=UTF-8"/>
<link rel="stylesheet" type="text/css" href="dmsstyle.css" />
<title>The dmr.ldap Schema</title>
</head>

<body>

  <div id="header"> <div class="headerBar"> </div> </div>

  <div id="main">

    <div id="content">

  <div class="schemaName"> dmr.ldap </div>

  <div class="summary">

    <div class="classList">
    <h2> Classes (4)</h2>
    <table>
      <tr>
      <td class="spacer"> </td>
      <td> <a class="deflink" href="#LDAPAttributeAUX"> LDAPAttributeAUX </a></td>
      </tr>
      <tr>
      <td class="spacer"> </td>
      <td> <a class="deflink" href="#LDAPClassAUX"> LDAPClassAUX </a></td>
      </tr>
      <tr>
      <td class="spacer"> </td>
      <td> <a class="deflink" href="#LDAPHierarchicObject"> LDAPHierarchicObject </a></td>
      <td> FQN </td>
      </tr>
      <tr>
      <td class="spacer"> </td>
      <td> <a class="deflink" href="#LDAPSchemaAUX"> LDAPSchemaAUX </a></td>
      </tr>
    </table>
    </div>  </div> <!--  summary -->

<div class="classDetails">

<h2> Class Details </h2>

  <table>

    <tr> <td class="className" colspan="4"> <a name="LDAPAttributeAUX"> LDAPAttributeAUX </a> </td></tr>
    <tr>
      <td class="spacer"> </td>
      <td>Description</td>
      <td colspan="2">The LDAPSchemaExtension class is used to extend the basic SchemaDefinition class with information required to map objects onto an LDAP repository.</td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Type</td>
      <td colspan="2">AUXILIARY</td>
    </tr>

  </table>

  <table>

    <tr>
      <td class="spacer"> </td>
      <td class="label">May</td>
      <td> <a href="dmr.ldap.html#reposName">reposName</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#String">String</a> </td>
      <td> This attribute indicates the name of an attribute or class when it is stored in a repository and added to that repository's schema. Generally speaking, we will always use the standard prefix for all attribute and class names. Like all other name values, this one must be globally unique. </td>
    </tr>

  </table>

  <table>

    <tr> <td class="className" colspan="4"> <a name="LDAPClassAUX"> LDAPClassAUX </a> </td></tr>
    <tr>
      <td class="spacer"> </td>
      <td>Description</td>
      <td colspan="2">The LDAPSchemaExtension class is used to extend the basic SchemaDefinition class with information required to map objects onto an LDAP repository.</td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Type</td>
      <td colspan="2">AUXILIARY</td>
    </tr>

  </table>

  <table>

    <tr>
      <td class="spacer"> </td>
      <td class="label">May</td>
      <td> <a href="meta.html#namingAttribute">namingAttribute</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#AttributeDefinition">AttributeDefinition</a> </td>
      <td> This attribute indicates the attribute that is used to name an object instance. The exact manner in which the naming attribute is used is specific to the implementation of the HierarchicObject derived class. <p> For instance, the DotNamedObject simply uses the value of the naming attribute and separates the attribute values with periods e.g. grandparent.parent.child. <p> For LDAP objects when a hierarchic name is composed for an object, the class name plus the value of the naming attribute (type:value) is used to create the name of an object. It is best if the naming attribute value is created by the application; it shouldn't be based on any user configurable value. </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label"> </td>
      <td> <a href="dmr.ldap.html#reposName">reposName</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#String">String</a> </td>
      <td> This attribute indicates the name of an attribute or class when it is stored in a repository and added to that repository's schema. Generally speaking, we will always use the standard prefix for all attribute and class names. Like all other name values, this one must be globally unique. </td>
    </tr>

  </table>

  <table>

    <tr> <td class="className" colspan="4"> <a name="LDAPHierarchicObject"> LDAPHierarchicObject </a> </td></tr>
    <tr>
      <td class="spacer"> </td>
      <td>Description</td>
      <td colspan="2">The LDAPHierarchicObject provides some additional structure and conventions to the HierarchicObject to make it usable in conjunction with an LDAP enabled directory server. Classes derived from LDAPHierarchicObject must be defined in a schema that has been extended with the LDAPSchemaExtension auxiliary class and must themselves be extended with the LDAPClassExtension auxiliary class; the class must have a defined naming attribute. Furthermore, naming attributes should be unique for each defined class.</td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Type</td>
      <td colspan="2">STRUCTURAL</td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td>Derived from</td>
      <td colspan="2">
      <a href="dmr.base.html#HierarchicObject">HierarchicObject</a>
      </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td>Wrapper</td>
      <td colspan="2">EXTENDED</td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td>Named by</td>
      <td colspan="2"> <a href="meta.html#FQN">FQN</a> </td>
    </tr>

  </table>

  <table>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Must</td>
      <td> <a href="meta.html#FQN">FQN</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#FullyQualifiedName">FullyQualifiedName</a> </td>
      <td> The fully qualified name of a hierarchic object. The exact form of the fqn is application specific. </td>
    </tr>

  </table>

  <table>

    <tr> <td class="className" colspan="4"> <a name="LDAPSchemaAUX"> LDAPSchemaAUX </a> </td></tr>
    <tr>
      <td class="spacer"> </td>
      <td>Description</td>
      <td colspan="2">The LDAPSchemaExtension class is used to extend the basic SchemaDefinition class with information required to map objects onto an LDAP repository.</td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Type</td>
      <td colspan="2">AUXILIARY</td>
    </tr>

  </table>

  <table>

    <tr>
      <td class="spacer"> </td>
      <td class="label">May</td>
      <td> <a href="dmr.ldap.html#ldapIdPrefix">ldapIdPrefix</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#String">String</a> </td>
      <td> The ldapIdPrefix is defined for use against an entire schema. It indicates the prefix that will be added to all class and attribute definitions that are loaded into the directory as schema. Having a prefix prevents possible collisions with existing schema definitions. The prefix should be short, 2 or 3 characters. </td>
    </tr>

  </table>

</div> <!-- classDetails -->

<div class="attributeDetails">

<h2> Attribute Details </h2>

  <table>

    <tr> <td class="className" colspan="3"> <a name="ldapIdPrefix"> ldapIdPrefix </a> </td></tr>
    <tr>
      <td class="spacer"> </td>
      <td colspan="2"> <div class="valueType"> P SV </div> <div class="attrType"> <a href="meta.html#String">String</a> </div> 
      </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Description</td>
      <td>The ldapIdPrefix is defined for use against an entire schema. It indicates the prefix that will be added to all class and attribute definitions that are loaded into the directory as schema. Having a prefix prevents possible collisions with existing schema definitions. The prefix should be short, 2 or 3 characters.</td>
    </tr>

    <tr> <td class="className" colspan="3"> <a name="reposName"> reposName </a> </td></tr>
    <tr>
      <td class="spacer"> </td>
      <td colspan="2"> <div class="valueType"> P SV </div> <div class="attrType"> <a href="meta.html#String">String</a> </div> 
      </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Description</td>
      <td>This attribute indicates the name of an attribute or class when it is stored in a repository and added to that repository's schema. Generally speaking, we will always use the standard prefix for all attribute and class names. Like all other name values, this one must be globally unique.</td>
    </tr>

  </table>

</div> <!-- attributeDetails -->

    </div>

    <div id="sidebar">
        <a class="navLink" href="contacts.html"> contacts</a>
        <a class="navLink" href="dmg.html"> dmg</a>
        <a class="navLink" href="dmp.html"> dmp</a>
        <a class="navLink" href="dmp.server.html"> dmp.server</a>
        <a class="navLink" href="dmr.base.html"> dmr.base</a>
        <a class="navLink" href="dmr.ldap.html"> dmr.ldap</a>
        <a class="navLink" href="dmt.html"> dmt</a>
        <a class="navLink" href="dmv.html"> dmv</a>
        <a class="navLink" href="map.html"> map</a>
        <a class="navLink" href="meta.html"> meta</a>
        <a class="navLink" href="mvw.html"> mvw</a>
    </div>
  </div> <!-- main -->

  <div id="footer"> </div>

</body>

</html>
